com.inscoper.nbo.Experiment

Represents the XML element Experiment. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Experiment()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(ExperimentID_Type value) Sets the value of the ID attribute.
ExperimentID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setPurpose(ExperimentPurpose_Type value) Sets the value of the Purpose attribute.
ExperimentPurpose_Type	getPurpose() Returns the value of the Purpose attribute.
void	resetPurpose() Resets the Purpose attribute to an unset state.
boolean	hasPurpose() Checks whether the optional Purpose attribute is present.
void	setLabellingMethod(String value) Sets the value of the LabellingMethod attribute.
String	getLabellingMethod() Returns the value of the LabellingMethod attribute.
void	setLabellingMethodTermAccession(String value) Sets the value of the LabellingMethodTermAccession attribute.
String	getLabellingMethodTermAccession() Returns the value of the LabellingMethodTermAccession attribute.
void	resetLabellingMethodTermAccession() Resets the LabellingMethodTermAccession attribute to an unset state.
boolean	hasLabellingMethodTermAccession() Checks whether the optional LabellingMethodTermAccession attribute is present.
void	setTag(String value) Sets the value of the Tag attribute.
String	getTag() Returns the value of the Tag attribute.
void	resetTag() Resets the Tag attribute to an unset state.
boolean	hasTag() Checks whether the optional Tag attribute is present.
void	setTagTermAccession(String value) Sets the value of the TagTermAccession attribute.
String	getTagTermAccession() Returns the value of the TagTermAccession attribute.
void	resetTagTermAccession() Resets the TagTermAccession attribute to an unset state.
boolean	hasTagTermAccession() Checks whether the optional TagTermAccession attribute is present.
void	setHystochemistryType(HystochemistryType_Type value) Sets the value of the HystochemistryType attribute.
HystochemistryType_Type	getHystochemistryType() Returns the value of the HystochemistryType attribute.
void	resetHystochemistryType() Resets the HystochemistryType attribute to an unset state.
boolean	hasHystochemistryType() Checks whether the optional HystochemistryType attribute is present.
void	setExperimenterRef_List(ExperimenterRefVector value) Sets the list of ExperimenterRef elements.
ExperimenterRefVector	getExperimenterRef_List() Returns the list of ExperimenterRef elements.
void	addToExperimenterRef_List(ExperimenterRef value) Adds a new ExperimenterRef element to this object.
void	clearExperimenterRef_List() Clear the list of ExperimenterRef.
void	setSample_List(SampleVector value) Sets the list of Sample elements.
SampleVector	getSample_List() Returns the list of Sample elements.
void	addToSample_List(Sample value) Adds a new Sample element to this object.
void	clearSample_List() Clear the list of Sample.
void	setMicrobeamManipulation_List(MicrobeamManipulationVector value) Sets the list of MicrobeamManipulation elements.
MicrobeamManipulationVector	getMicrobeamManipulation_List() Returns the list of MicrobeamManipulation elements.
void	addToMicrobeamManipulation_List(MicrobeamManipulation value) Adds a new MicrobeamManipulation element to this object.
void	clearMicrobeamManipulation_List() Clear the list of MicrobeamManipulation.
void	setDescription(Description value) Sets the value of the Description element.
Description	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
Experiment	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	Experiment(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Experiment obj)

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.Experiment;

Represents the XML element Experiment.

This element describes the experiment during which this Image was acquired. The optional Description element may contain free text to further describe the experiment.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Experiment

public Experiment()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    ExperimentID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A unique identifier for this Experiment.

function getID

public ExperimentID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A unique identifier for this Experiment.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A unique identifier for this Experiment.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A unique identifier for this Experiment.

function setName

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A user assigned name for this Experiment.

function getName

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A user assigned name for this Experiment.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

A user assigned name for this Experiment.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

Return: true if the optional attribute has been set, false otherwise

A user assigned name for this Experiment.

function setPurpose

public void setPurpose(
    ExperimentPurpose_Type value
)

Sets the value of the Purpose attribute.

Parameters:

value The value to set

This field records a term used the general purpose of the imaging experiment performed in this case.

function getPurpose

public ExperimentPurpose_Type getPurpose()

Returns the value of the Purpose attribute.

Return: The value of the attribute

This field records a term used the general purpose of the imaging experiment performed in this case.

function resetPurpose

public void resetPurpose()

Resets the Purpose attribute to an unset state.

This field records a term used the general purpose of the imaging experiment performed in this case.

function hasPurpose

public boolean hasPurpose()

Checks whether the optional Purpose attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records a term used the general purpose of the imaging experiment performed in this case.

function setLabellingMethod

public void setLabellingMethod(
    String value
)

Sets the value of the LabellingMethod attribute.

Parameters:

value The value to set

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getLabellingMethod

public String getLabellingMethod()

Returns the value of the LabellingMethod attribute.

Return: The value of the attribute

This field records a term that describes the method used for the Labelling or Visualization of the structures (i.e. molecular components) under study in this Experiment. The use of a sub-class of the 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) term from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function setLabellingMethodTermAccession

public void setLabellingMethodTermAccession(
    String value
)

Sets the value of the LabellingMethodTermAccession attribute.

Parameters:

value The value to set

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function getLabellingMethodTermAccession

public String getLabellingMethodTermAccession()

Returns the value of the LabellingMethodTermAccession attribute.

Return: The value of the attribute

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function resetLabellingMethodTermAccession

public void resetLabellingMethodTermAccession()

Resets the LabellingMethodTermAccession attribute to an unset state.

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function hasLabellingMethodTermAccession

public boolean hasLabellingMethodTermAccession()

Checks whether the optional LabellingMethodTermAccession attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Accession ID for the term used to describe the Visualization Method (also often referred to as Labelling Method). The use of a sub-classes of 'Visualization Method' (http://purl.obolibrary.org/obo/FBbi_00000031) from the Biological Imaging Methods Ontology (FBbi; https://www.ebi.ac.uk/ols/ontologies/fbbi) is recommended.

function setTag

public void setTag(
    String value
)

Sets the value of the Tag attribute.

Parameters:

value The value to set

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function getTag

public String getTag()

Returns the value of the Tag attribute.

Return: The value of the attribute

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function resetTag

public void resetTag()

Resets the Tag attribute to an unset state.

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function hasTag

public boolean hasTag()

Checks whether the optional Tag attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field describes small molecules, peptides or full proteins that were used as label in this Experiment. The use of a sub-class of the 'Tag' (http://purl.obolibrary.org/obo/MI_0507) term from the Molecular Interactions Controlled Vocabulary (MI; http://purl.obolibrary.org/obo/mi.owl) is recommended.

function setTagTermAccession

public void setTagTermAccession(
    String value
)

Sets the value of the TagTermAccession attribute.

Parameters:

value The value to set

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function getTagTermAccession

public String getTagTermAccession()

Returns the value of the TagTermAccession attribute.

Return: The value of the attribute

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function resetTagTermAccession

public void resetTagTermAccession()

Resets the TagTermAccession attribute to an unset state.

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function hasTagTermAccession

public boolean hasTagTermAccession()

Checks whether the optional TagTermAccession attribute is present.

Return: true if the optional attribute has been set, false otherwise

This records the Accession ID for the term used to describe the Tag used in this Experiment. The use of a sub-class of http://purl.obolibrary.org/obo/MI_0507 is recommended.

function setHystochemistryType

public void setHystochemistryType(
    HystochemistryType_Type value
)

Sets the value of the HystochemistryType attribute.

Parameters:

value The value to set

This field records a term that describes the general category of Histochemistry staining used in this case.

function getHystochemistryType

public HystochemistryType_Type getHystochemistryType()

Returns the value of the HystochemistryType attribute.

Return: The value of the attribute

This field records a term that describes the general category of Histochemistry staining used in this case.

function resetHystochemistryType

public void resetHystochemistryType()

Resets the HystochemistryType attribute to an unset state.

This field records a term that describes the general category of Histochemistry staining used in this case.

function hasHystochemistryType

public boolean hasHystochemistryType()

Checks whether the optional HystochemistryType attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records a term that describes the general category of Histochemistry staining used in this case.

function setExperimenterRef_List

public void setExperimenterRef_List(
    ExperimenterRefVector value
)

Sets the list of ExperimenterRef elements.

Parameters:

value The new list of ExperimenterRef elements

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function getExperimenterRef_List

public ExperimenterRefVector getExperimenterRef_List()

Returns the list of ExperimenterRef elements.

Return: The list of ExperimenterRef elements

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function addToExperimenterRef_List

public void addToExperimenterRef_List(
    ExperimenterRef value
)

Adds a new ExperimenterRef element to this object.

Parameters:

value The element to add

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function clearExperimenterRef_List

public void clearExperimenterRef_List()

Clear the list of ExperimenterRef.

This empty element refers to the Scientist (i.e., Experimenter) that performed this experiment.

function setSample_List

public void setSample_List(
    SampleVector value
)

Sets the list of Sample elements.

Parameters:

value The new list of Sample elements